home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d10 / uplot20b.arc / UPLOT.DOC < prev    next >
Text File  |  1990-10-05  |  18KB  |  595 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.                     UPLOT(C) v2.0 DOCUMENTATION
  28.                          (Shareware package)
  29.  
  30.                           BY:  Roy L. Lung
  31.  
  32.                           October 5, 1990
  33.  
  34.  
  35.                             2055 Mill Road
  36.                        Mechanicsville, MD  20659
  37.                          (301) 884-4766 voice
  38.                        (301) 884-8549 KEEPASM BBS
  39.                     HST 9600/2400/1200/300 BAUD 8-N-1
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73.  
  74.  
  75.  
  76.  
  77.  
  78.  
  79.  
  80.  
  81.  
  82.  
  83.  
  84.  
  85.  
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.                  UPLOT(C) - Universal Plotting Program
  97.  
  98.          COPYRIGHT (C) 1990 by Roy L. Lung, ALL RIGHTS RESERVED.
  99.  
  100.                       Support on KEEPASM - BBS
  101.  
  102.  
  103.                  You should have the following files:
  104.  
  105.                   README .NOW = MUST read text file
  106.                   INSTALL.EXE = Sets up UPLOT.DAT
  107.                   UPLOT  .DOC = THIS document file
  108.                   UPLOT  .EXE = Universal plotting program
  109.                   UPLOT  .HLP = UPLOT(C) help file
  110.                   STUPLOT.BAT = Easy operation file
  111.                   DEMO   .BAT = Quick demonstration
  112.                   PLOT1  .PLT = Sample plots
  113.                   PLOT2  .PLT = Sample plots
  114.                   PLOT3  .PLT = Sample plots
  115.                   STICK  .EXE = Collect Joystick Data
  116.                   MODE2  .DAT = Used by INSTALL.EXE
  117.                   MODE3  .DAT = Used by INSTALL.EXE
  118.                   MODE4  .DAT = Used by INSTALL.EXE
  119.                   MODE8  .DAT = Used by INSTALL.EXE
  120.                   MODE9  .DAT = Used by INSTALL.EXE
  121.                   MODEK  .DAT = Used by INSTALL.EXE
  122.                   MODEL  .DAT = Used by INSTALL.EXE
  123.                   MODEM  .DAT = Used by INSTALL.EXE
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.  
  137.  
  138.  
  139.  
  140.  
  141.          To get started:
  142.  
  143.          1.   Copy all these files to a Subdirectory
  144.               of your choice.  [ suggest: \UPLOT ]
  145.               To make the new directory enter: MD \UPLOT
  146.               Enter: COPY A:\*.* C:\UPLOT {if file are on A: drive}
  147.  
  148.          2.   Change your directory to the default: \UPLOT
  149.               Enter: CD \UPLOT
  150.  
  151.          3.   Next to read the README.NOW text file with your text
  152.               editor. Follow the instruction included with the editor.
  153.               Skip step 4 to speed up getting started.
  154.  
  155.          4.   To print the README.NOW, enter: "PRINT README.NOW" at
  156.               your DOS prompt.
  157.  
  158.          5.   Read the printed README.NOW file!
  159.  
  160.          6.   Run the demonstration batch file by entering: DEMO
  161.               Read the text and instructions in it carefully!
  162.  
  163.          7.   To see the command line format of either STICK(C)
  164.               or UPLOT(C) just enter their name at the DOS command
  165.               line.  [ STICK ] or [ UPLOT ]
  166.  
  167.          8.   Read the batch files included with the files.  They will
  168.               help you understand the command line requirements - this
  169.               will help you when your ready to make your own customized batch
  170.               files.
  171.  
  172.  
  173.          The following is a list of keys and their function when using
  174.          UPLOT(C):
  175.  
  176.          <Right Arrow> = Move index right - or only actives the index line to
  177.                          be displayed if it is the first time a index
  178.                          positioning key has been pressed.  Holding the arrow
  179.                          key down will invoke rapid movement to quickly get to
  180.                          the new position desired (also see the <I> key).
  181.  
  182.           <Left Arrow> = Move index left - or only actives the index line to
  183.                          be displayed if it is the first time a index
  184.                          positioning key has been pressed. Holding the arrow
  185.                          key down will invoke rapid movement to quickly get to
  186.                          the new position desired (also see the <I> key).
  187.  
  188.           <Up Arrow>   = Limits info back - the limits information line will
  189.                          display the peaks and lowest data values in your plot
  190.                          file and even place a marker for its position in the
  191.                          plot box and give its offset into the data file on
  192.                          the top of the plot box.  The data values of the
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.  
  203.  
  204.  
  205.                          other plots at that position are also shown.
  206.  
  207.           <Down Arrow> = Limits info forward (see <Up Arrow> description)
  208.  
  209.           <Home Key>   = Moves the index to the beginning of the plot screen.
  210.                          (the position of the index into the plot data is
  211.                          updated top-right of the plot window box)
  212.  
  213.           <End Key>    = Moves the index to the end of the plot screen.
  214.                          (the position of the index into the plot data is
  215.                          updated top-right of the plot window box)
  216.  
  217.           <ESC>=escape = Exit plotting program - returns to system.
  218.  
  219.           <PAGE UP>    = Magnifies active plots - this is a rescaling of the
  220.                          data of the active plots and will cause the plots to
  221.                          be redrawn.
  222.  
  223.           <PAGE DOWN>  = Reduces active plots - the opposite of <PAGE UP> key.
  224.  
  225.           NOTE: Page up/dn will only affect
  226.                 scaling amplitude of currently
  227.                 active plots and will redraw
  228.                 active plots.
  229.  
  230.           <1>          = Plot x1 toggle - you will see the current state of
  231.                          this flag in the upper right section of the screen.
  232.                          (see note below)
  233.  
  234.           <2>          = Plot y1 toggle
  235.  
  236.           <3>          = Plot x2 toggle
  237.  
  238.           <4>          = Plot y2 toggle
  239.  
  240.           <5>          = Plot TIME STAMP toggle
  241.  
  242.           NOTE: <1>-<5> only show affect on redraw; upper right corner of
  243.                 your screen will show current state of the plot toggles -
  244.                 0 = off, 1 = on.  The first active plot scale is displayed on
  245.                 the right of the plot box - to see other plot scales and
  246.                 disable the displaying of undesired plots then you must
  247.                 deactivate the plots before it - i.e. plots x1,y1,x2 are
  248.                 currently displayed so to see x2's scale and plot alone press
  249.                 <1> and <2> then <F2> to redraw screen.
  250.                 [new scale will be for x2]
  251.  
  252.  
  253.           <B> or <b>   = Sets the beginning of a new window at the current
  254.                          index position.  The ending position must also be set
  255.                          before the new window can be displayed.
  256.  
  257.           <C> or <c>   = Moves the index to the center of the current plot
  258.                          window.
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.  
  269.  
  270.  
  271.                          (the position of the index into the plot data is
  272.                          updated top-right of the plot window box)
  273.  
  274.           <E> or <e>   = Window ends at index - sets the ending position of a
  275.                          new window and causes the new window to be displayed
  276.                          (activates window).
  277.  
  278.           <H> or <h>   = Invokes a help window with the information needed for
  279.                          remembering the commands and registration
  280.                          information.  <F1> is same.
  281.  
  282.           <I> or <i>   = Set index position manually - a prompt will appear on
  283.                          the last line of the screen.  Enter the new position
  284.                          to place the index line.  If the position is less
  285.                          than the first plot point in the current window then
  286.                          it will be moved to the home position.  If past the
  287.                          end of the current window then it will be placed at
  288.                          the last position on the current window.
  289.                          (the position of the index into the plot data is
  290.                          updated top-right of the plot window box)
  291.  
  292.           <L> or <l>   = Plot by line toggle - the plotting can be by points
  293.                          or by drawing lines between the points.  The screen
  294.                          will be redrawn.  The line plotting mode can be very
  295.                          useful when the points have much change in amplitude
  296.                          between them or when looking for peaks/valleys.
  297.  
  298.           <N> or <n>   = New plot - restarts allowing a new plot name to be
  299.                          entered for loading.  You may only load new plots
  300.                          with the same number of data fields - i.e. if the new
  301.                          plot has a time stamp and the old one did not then
  302.                          the results of the plots will be invalid or cause a
  303.                          loading error!  To plot a different type of plot you
  304.                          must restart UPLOT(C) entering the proper information
  305.                          as prompted or in the command line.  To see the
  306.                          command line format - key in <UPLOT> at the DOS
  307.                          command line.
  308.  
  309.           <P> or <p>   = Print the plot screen - you will be prompted for the
  310.                          type of printout desired.  If your printer has a
  311.                          narrow carriage you should not select the wide type
  312.                          printouts!  You can redirect the printout to a file
  313.                          for multiple printing or transfer to a system with a
  314.                          printer desired for the printing.  The function keys
  315.                          <F3> - <F10> will help you remove unwanted
  316.                          information from the screen before you select this
  317.                          printing feature.
  318.  
  319.           NOTE: Print feature only available with registered versions!
  320.  
  321.           <S> or <s>   = Sound toggle (ON/OFF) - toggle sound off if you
  322.                          dislike the beeping on errors or prompts.
  323.  
  324.           <T> or <t>   = Text entry for customizing screen information
  325.  
  326.  
  327.  
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.  
  335.  
  336.  
  337.                          by user - use it to label individual plots or
  338.                          enter other important captions.
  339.  
  340.           <W> or <w>   = Window toggle - switches between full screen
  341.                          and a smaller view screen of plot data.  This
  342.                          feature can be very useful for viewing details.
  343.  
  344.           <Z> or <z>   = Zoom set window - a manual entry method for
  345.                          setting beginning and ending window positions.
  346.  
  347.           <F1> = Same as <H> key.
  348.  
  349.           <F2> = redraw plot - removes index line marker from display and
  350.                  removes limit line markers (except the last active limit).
  351.                  This has the effect of cleaning up the screen.
  352.  
  353.           <F3> = Clock display toggle - turns on or off the display of the
  354.                  clock in the upper right corner of the screen.  The Clock
  355.                  line includes S=*### for the amount of programs internal
  356.                  stack memory.  If TSR's are corrupting the stack you will see
  357.                  the number changing greatly.  Some changes are expected as
  358.                  different routines within UPLOT(C) are executed and this is
  359.                  normal.  The M=####K lets you tell the amount of free memory
  360.                  available to your system for other purposes or larger plot
  361.                  files.  If this number is less than 5K you should increase
  362.                  the amount of available memory in the window for execution of
  363.                  UPLOT(C) or reduce the size of the plots to be displayed.
  364.  
  365.           <F4> = File name display toggle - allows the removal of the active
  366.                  plots path (if different than default) and files name from
  367.                  being displayed on the screen.
  368.  
  369.           <F5> = Minimum/Maximum screen ranges of currently displayed plot
  370.                  window toggle.  (removes it from being displayed)
  371.  
  372.           <F6> = Time stamp display toggle (removes it from being displayed)
  373.  
  374.           <F7> = Amplitude multiplier display toggle (removes it from being
  375.                  displayed)
  376.  
  377.           <F8> = Amplitude scale display toggle (removes it from being
  378.                  displayed)  This is the scale on the right of the plot.
  379.  
  380.           <F9> = Relative position scale toggle (removes it from being
  381.                  displayed)  This is the scale on the bottom of the plot.
  382.  
  383.          <F10> = Amplitude weight scale display toggle (removes it from being
  384.                  displayed)  This is the scale on the right of the plot.
  385.  
  386. Supplemental information:
  387.  
  388.          You can not hurt anything by trying the different keys to see their
  389.          response so feel free to experiment.  The worst that could happen is
  390.          for UPLOT(C) to abort with an error message.  All fatal errors should
  391.  
  392.  
  393.  
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.  
  401.  
  402.  
  403.          be recorded in a file named UPLOT.ERR which can be deleted or
  404.          uploaded to KEEPASM - BBS when you desire for me to look into the
  405.          trouble.  Also include a description of your problem and all data
  406.          files affected (plots of your own).
  407.  
  408.  
  409.           Tips: If you want to magnify only one plot and leave the
  410.          others the same, then deactivate all but the plot to be
  411.          affected (see help on keys 1 - 5).  Use the <PAGE UP> key
  412.          till it is at the desired magnification.  After reactivating
  413.          the other plots use the <F2> key to force a redraw of the
  414.          plots.  The magnification will remain in effect till
  415.          de-magnified with the <PAGE DN> key.  Still remember - ALL
  416.          active plots are affected by the <PAGE UP/DN> keys!
  417.  
  418.  
  419.          The keys that will affect STICK(C) will be displayed when you
  420.          run the program allowing the display mode to be ON.  The
  421.          maximum speed of sampling the Joystick ports will depend on
  422.          your system speed and whether or not you have set the sample
  423.          count and allowed displaying of the stick data real-time. The
  424.          program will not allow a sampling speed less than ONE
  425.          Millisecond and you would have to have a very fast system to
  426.          actually attain that rate.  My PC/AT system would peak at
  427.          about TWO Milliseconds!  In actuality a speed of 20-50
  428.          Milliseconds is ample to track the patterns.  The combination
  429.          of STICK(C) with UPLOT(C) makes a good tester for your
  430.          joysticks also!  You can look for jumping or spiking of the
  431.          sample data to see if you have a faulty potentiometer on one
  432.          of the axis (It may also show up as a flat spot).
  433.  
  434.          STICK(C) can also show the activity of the joystick buttons
  435.          when used in the slow speed mode (not setting the sample
  436.          rate).
  437.  
  438.          UPLOT(C) can display up to 5 plots at the same time.  The
  439.          last of these is used for time stamping.  The maximum number
  440.          of plot points UPLOT(C) can handle will vary with your system
  441.          memory, depth of samples, size of each sample, and whether
  442.          Time Stamping is used.  The maximum including Time Stamping
  443.          is 278,228 unique plot points!  The maximum number of
  444.          plot points per axis is 65,476 in byte mode (16,324 if Time
  445.          Stamping is included).  This number should be more than
  446.          adequate for most any plot data file that would be expected
  447.          to be used on a "in memory mode" PC platform.  Only a "file
  448.          mode" could handle larger number of plot points but the speed
  449.          would be much slower.  A future registered version might
  450.          include this feature.  If you have a need for plotting larger
  451.          files, please let me know and I will probably work on it.  If
  452.          you have a special application for which you would like a
  453.          customized version of UPLOT(C), please let me know also!  I
  454.          will charge reasonable rates with the understanding that I
  455.          could offer the program with future releases.
  456.  
  457.  
  458.  
  459.  
  460.  
  461.  
  462.  
  463.  
  464.  
  465.  
  466.  
  467.  
  468.  
  469.  
  470.  
  471.  
  472.  
  473.  
  474.  
  475.  
  476.  
  477.  
  478.  
  479.  
  480.  
  481.  
  482.  
  483.          REGISTERING:
  484.  
  485.             To receive a registered version of UPLOT(C) and STICK(C)
  486.             please send a donation of $25.00 USA to:
  487.  
  488.                 KEEPASM BBS Service
  489.                 Roy L. Lung
  490.                 2055 Mill Road
  491.                 Mechanicsville, MD  20659
  492.  
  493.  
  494.             You will receive the latest version which will have <P>
  495.          (print) enabled for printing on Epson EX/FX-86e/FX-800
  496.          compatible and IBM Proprinter/Proprinter II and Citizen
  497.          MSP-50/55 compatible IBM PC printers. Also more documentation
  498.          which will include details on data file structure.  This
  499.          extra documentation will help you convert other plot data
  500.          sources to be useable with UPLOT(C).  To receive a copy of
  501.          the source code for STICK(C) and UPLOT(C) please send a
  502.          donation of $100.00 USA to the above address and request the
  503.          source code be sent.  Both STICK(C) and UPLOT(C) will work
  504.          best when not used on a multitasking system.  Having a color
  505.          EGA or VGA screen will greatly improve both speed and
  506.          usefulness.  Also, speed can be greatly improved with the
  507.          addition of a Math Co-Processor (8087 - 80387) in your
  508.          system.  If you desire additional printer interfaces or other
  509.          features to be included in future versions - PLEASE send me a
  510.          note with your registration.  In the registered version more
  511.          function keys will be used to control the screens displayed
  512.          information to allow customizing printouts for presentations.
  513.  
  514.  
  515.  
  516. PS       If your system clock loses time while running STICK(C)
  517.          a reboot will restore the time.
  518.  
  519.  
  520.  
  521.  
  522.  
  523.  
  524.  
  525.  
  526.  
  527.  
  528.  
  529.  
  530.  
  531.  
  532.  
  533.  
  534.  
  535.  
  536.  
  537.  
  538.  
  539.          [end of UPLOT.DOC]
  540.  
  541.  
  542.  
  543.  
  544.  
  545.  
  546.  
  547.  
  548.  
  549.  
  550.  
  551.  
  552.  
  553.  
  554.  
  555.  
  556.  
  557.  
  558.  
  559.  
  560.  
  561.  
  562.  
  563.  
  564.  
  565.  
  566.  
  567.  
  568.  
  569.  
  570.  
  571.  
  572.  
  573.  
  574.  
  575.  
  576.  
  577.  
  578.  
  579.  
  580.  
  581.  
  582.  
  583.  
  584.  
  585.  
  586.  
  587.  
  588.  
  589.  
  590.  
  591.  
  592.  
  593.  
  594.  
  595.